[chore] Prepare fiest release #4
Conversation
baseballyama
force-pushed
the
first-release
branch
4 times, most recently
from
fb0a9d3
to
cb829f6
Compare
🦋 Changeset detectedLatest commit: 458e24c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
baseballyama
force-pushed
the
first-release
branch
4 times, most recently
from
a439aa3
to
a325654
Compare
baseballyama
force-pushed
the
first-release
branch
from
a325654
to
458e24c
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| if (codingGuide.path != null && codingGuide.level != null) { | ||
| const markdown = await fs.promises.readFile(codingGuide.path, "utf-8"); | ||
| const parsed = parseMarkdown(markdown); | ||
| return chunkMarkdownByLevel(parsed, codingGuide.level); | ||
| const chunked = chunkMarkdownByLevel(parsed, codingGuide.level); | ||
| return chunked.filter((chunk) => codingGuide.enablePattern.test(chunk)); |
There was a problem hiding this comment.
全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定することが必要です。ここでは、markdown、parsed、chunkedの変数と、chunkMarkdownByLevel関数の引数と戻り値の型が指定されていません。これらに適切な型を指定してください。
Reference: ## 型定義の適用
| Meta | Content |
|---|---|
| Level | 必須 |
| Link | https://www.typescriptlang.org/docs/handbook/2/everyday-types.html |
| AI Review | ON |
説明
全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定すること。
理由
型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。
例
// 良いコードの例
function add(x: number, y: number): number {
return x + y;
}
// 悪いコードの例
function add(x, y) {
return x + y;
}例外ケース
- ライブラリが提供する関数や変数の型が any である場合は、適宜型アサーションを使用する。
リファクタリングガイドライン
既存のコードでは、任意の型が使われていた場合、それを具体的な型に置き換えていく。新規コードでは初めから型を適用する。
| reader: getEnv("CODING_GUIDE_READER") || undefined, | ||
| path: getEnv("CODING_GUIDE_PATH") || undefined, |
There was a problem hiding this comment.
各変数に対して型が明示的に指定されていません。型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。以下のように修正してください。
reader: string | undefined = getEnv("CODING_GUIDE_READER") || undefined,
path: string | undefined = getEnv("CODING_GUIDE_PATH") || undefined,
level: number | undefined = Number(getEnv("CODING_GUIDE_LEVEL")) || undefined,
enablePattern: RegExp = RegExp(
getEnv("CODING_GUIDE_ENABLE_PATTERN", { defaultValue: ".*" })
),Reference: ## 型定義の適用
| Meta | Content |
|---|---|
| Level | 必須 |
| Link | https://www.typescriptlang.org/docs/handbook/2/everyday-types.html |
| AI Review | ON |
説明
全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定すること。
理由
型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。
例
// 良いコードの例
function add(x: number, y: number): number {
return x + y;
}
// 悪いコードの例
function add(x, y) {
return x + y;
}例外ケース
- ライブラリが提供する関数や変数の型が any である場合は、適宜型アサーションを使用する。
リファクタリングガイドライン
既存のコードでは、任意の型が使われていた場合、それを具体的な型に置き換えていく。新規コードでは初めから型を適用する。
No description provided.